#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (c) 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# We kindly request you to use one or more of the following phrases to refer to
# foxBMS in your hardware, software, documentation or advertising materials:
#
# - "This product uses parts of foxBMS®"
# - "This product includes parts of foxBMS®"
# - "This product is derived from foxBMS®"


"Miscellaneous helper functions for the GUI"

import webbrowser

import wx
from fgui import FOXBMS_DOC_URL
from fgui.misc.info_dialog import FoxbmsInfoDialog
from fgui.misc.logo import logo_foxbms


def cb_open_documentation(_, **args):
    """Shows the foxBMS documentation from local source if it exists, from
    web if it does not"""
    open_documentation()


def open_documentation():
    """Shows the foxBMS documentation from local source if it exists, from
    web if it does not"""
    webbrowser.open(FOXBMS_DOC_URL)


def cb_show_info(_, **args):
    """Shows the program information"""
    show_info()


def show_info():
    """Shows the program information"""
    about_dialog = FoxbmsInfoDialog(None, title="About foxBMS 2")
    about_dialog.ShowModal()
    about_dialog.Destroy()


def get_icon():
    """Returns the foxBMS logo as icon"""
    _icon = wx.Icon()
    logo_img = wx.Image(logo_foxbms.GetImage())
    logo_img_size = logo_img.GetSize()
    resized = logo_img_size / 5
    logo_img.Rescale(resized[0], resized[1])
    image = wx.Bitmap(logo_img)
    _icon.CopyFromBitmap(image)
    return _icon
